home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 022a / giflog.zip / GIFLOG.DOC < prev    next >
Text File  |  1991-06-30  |  22KB  |  612 lines
  1.  
  2.  
  3.  
  4.  
  5.                                                                         1
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                            -------------------------------
  15.                            -         Giflog v1.1         -
  16.                            - GIF File Cataloging Program -
  17.                            -------------------------------
  18.                            -      User  Information      -
  19.                            -------------------------------
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.                         Executable Program and Documentation
  60.                        Copyright (C)1990,1991 by Michael Rice
  61.  
  62.  
  63.  
  64.                                                                         2
  65.  
  66.  
  67.  
  68.  
  69.                               
  70.           Introduction:
  71.           -------------
  72.  
  73.           Giflog is a simple, easy to use program to help you manage your
  74.           GIF picture file collection.  If you are anything like me,
  75.           collecting these GIF files has gotten a bit out of hand.  At the
  76.           this time I have about 300 1.2Mb disks with GIF files on them.
  77.           Most of the files sit in one of my floppy boxes and never get
  78.           looked at.  This can cause quite a problem for the collector.  If
  79.           I obtain a GIF today how can I remember if I already have it or
  80.           not?  I certainly don't want to keep multiple copies of the same
  81.           file.  Giflog helps with this in quite a number of ways.  First,
  82.           it has a built in CRC (Cyclic Redundancy Check) algorithm that
  83.           will help you spot duplicate files.  Secondly, it lets you add
  84.           comments for each file while cataloging so you can remember what
  85.           is in that file at a later date.  Thirdly, it has report printing
  86.           features to let you know the details of each file such as
  87.           filesize, resolution, name, and comment.  There are other nifty
  88.           little features that make it a nice program to have around.  I
  89.           hope you'll give it a try.  What do you have to lose?
  90.  
  91.  
  92.  
  93.           Installation:
  94.           -------------
  95.  
  96.           Giflog will create the file GIFLOG.CAT as a default.  So the
  97.           first time you run Giflog, GIFLOG.CAT will be the name of your
  98.           catalog file.  You may change this by going to the FILE menu LOAD
  99.           option and loading in the filename you desire.  You may only load
  100.           a filename.  Do NOT try to use a full pathname in the LOAD
  101.           option.  To make this your default go to the OPTIONS menu SAVE
  102.           CONFIGURATION option.
  103.  
  104.           Giflog will also look for the file GIFLOG.CFG.  It contains the
  105.           Options settings.  If this file does not exist, it will use the
  106.           default values.
  107.  
  108.           Giflog will always look in two places for GIFLOG.CFG and your
  109.           catalog files (normally GIFLOG.CAT).  It will first check your
  110.           environment for the variable GIFLOG.  If this exists it will look
  111.           in the directory assigned to the GIFLOG variable.  If it doesn't
  112.           exist it will look in the directory from which you ran
  113.           GIFLOG.EXE.  You need to setup in one of the following ways:
  114.  
  115.           1) In your AUTOEXEC.BAT file add the following line:
  116.  
  117.           SET GIFLOG=\GIFLOG\PATH\
  118.  
  119.           Where "\GIFLOG\PATH" is the directory you want GIFLOG.CAT and
  120.           GIFLOG.CFG to be kept.  Don't forget the trailing "\" as it is
  121.  
  122.  
  123.  
  124.                                                                         3
  125.  
  126.  
  127.           essential.  After this is done you need to also put GIFLOG.EXE in
  128.           a directory that is in your PATH or set your PATH to include
  129.           GIFLOG.EXE.  You now can run Giflog from any directory in your
  130.           system.
  131.  
  132.           2) You may also put GIFLOG.EXE into a directory and specifically
  133.           change to that directory before running Giflog.  If this is done
  134.           GIFLOG.CAT, GIFLOG.CFG, and GIFLOG.EXE will all be in the same
  135.           directory.  You can put the needed commands into a batch file
  136.           (We'll say GIFLOG.BAT) and put this batch file somewhere in your
  137.           PATH.  You can then run Giflog by typing GIFLOG at any prompt.
  138.           With the help of the PUSHDIR and POPDIR utility you can even
  139.           return to the directory you started in.  Below is a sample batch
  140.           file, that I have included with Giflog:
  141.  
  142.           @ECHO OFF
  143.           PUSHDIR > NULL
  144.           CD \PATH\OF\GIFLOG
  145.           GIFLOG
  146.           POPDIR > NULL
  147.  
  148.  
  149.  
  150.           Basic Features:
  151.           ---------------
  152.  
  153.           Giflog is a set of procedures run from an easy-to-use pulldown
  154.           menu.  The menu options may be selected by either the mouse, the
  155.           keyboard, or a combination of both.  In general, the left mouse
  156.           button will select an option and the right button will remove a
  157.           menu.  When using the mouse you must unselect a menu with the
  158.           right button before moving to another menu.  You may remove the
  159.           mouse cursor by pressing Alt-M.  With the keyboard, you move with
  160.           the cursor keys, select with the RETURN key, and unselect with
  161.           the ESCAPE key.  You may also select an option by pressing the
  162.           letter that is highlighted in red.  You may hit F1 at any point
  163.           to get a brief help message.  These aren't meant to be
  164.           comprehensive, but may be of some use to those who are a bit
  165.           lost.
  166.  
  167.           The program was written in C with the Turbo C++ compiler.  The
  168.           menuing features are from TCU v3.1a (Turbo C Utilities) by Karl
  169.           Keyte.  I highly recommend this!
  170.  
  171.  
  172.  
  173.           File Menu Options:
  174.           ------------------
  175.  
  176.           *Save Catalog:
  177.           This saves the current catalog including any new changes made
  178.           since the last save.  The old catalog is backed up in the file
  179.           GIFLOG.BUP.
  180.  
  181.  
  182.  
  183.                                                                         4
  184.  
  185.  
  186.           *Load Catalog:
  187.           This loads a catalog file from disk.  You can use this to load
  188.           GIFLOG.BUP if you just made a mistake, or if you are using
  189.           multiple catalog files you can use this to load them.  If you
  190.           have made changes to the current catalog it will ask you if you
  191.           want to save first.
  192.  
  193.  
  194.           *Add Comments:
  195.           This allows you to add comments to a specified volume.  You can
  196.           also add comments by setting the auto-commenting feature on.
  197.  
  198.  
  199.           *Activate Viewer:
  200.           This will try to activate a GIF file viewer.  You must have the
  201.           pathname/filename and command line options of the viewer set from
  202.           the OPTIONS menu.  The default is CSHOW.EXE.  It is assumed that
  203.           CSHOW.EXE is somewhere in your PATH since the full pathname is
  204.           not specified.  You must also have enough free memory to do this.
  205.           This shouldn't be a problem unless you have a huge catalog file.
  206.           Some viewers, such as CSHOW, VUIMG, and VPIC, work well with this
  207.           option.
  208.  
  209.  
  210.           *Delete File:
  211.           This option allows you to remove only one file from a volume.  It
  212.           is useful when you find a duplicate file in your catalog.  It
  213.           asks for a volume and a file and deletes it if the file is in the
  214.           catalog.  It also updates volume and file information.  Use this
  215.           when you only want to remove a few files from the catalog, and
  216.           the Uncatalog function when you want to remove the whole volume.
  217.  
  218.  
  219.           *About GIFLOG:
  220.           This will display a screen full of information about GIFLOG, such
  221.           as where I can be reached, and a few restrictions.
  222.  
  223.  
  224.  
  225.           Catalog Menu Options:
  226.           ---------------------
  227.  
  228.           *Catalog:
  229.           This is the heart of the Giflog program.  This option will add
  230.           GIF files to the database.  There are two ways in which
  231.           cataloging can work.  The first is designed to work mainly on
  232.           floppy disks.  Giflog will find all the GIFS in the root
  233.           directory of a disk, associate them with the disk's volume label,
  234.           and store them in the database.  All disks cataloged in this way
  235.           must have a volume label.  If it does not have one, you will be
  236.           given the chance to add it.  You can set the drive to catalog
  237.           from, in the OPTIONS menu.  If the files are already in the
  238.           catalog it notifies you and adds the files that are new.  If the
  239.  
  240.  
  241.  
  242.                                                                         5
  243.  
  244.  
  245.           auto-commenting option is set on, you will then be given a chance
  246.           to update or create comments for each file.
  247.  
  248.           Giflog does not check to see that you have a unique volume label.
  249.           All disks labelled the same are thought of as one volume.  I
  250.           suggest using a labelling method that makes duplicates easy to
  251.           spot, and makes disks easy to find.  I use the label "GIFS xxx"
  252.           where xxx is a number which counts up with each new disk.
  253.  
  254.           The other option you have for cataloging is from a subdirectory.
  255.           This is useful if you have a small collection which you keep on
  256.           your hard drive, or if keep some on floppies and some in
  257.           subdirectories.  To use this you must set the option in the
  258.           OPTIONS menu CATALOG DRIVE option.  With this option set, Giflog
  259.           will ask you for the full pathname of the subdirectory you want
  260.           to catalog.  A full pathname starting with a "\" is required.
  261.           You may also specify the drive in the pathname, but it will
  262.           default to the drive set in the CATALOG DRIVE option.  Giflog
  263.           will use the innermost directory as the volume.  For example in
  264.           the path C:\TEMP\GIFS\BIGCOLOR, the volume would be BIGCOLOR.
  265.           The same rules apply for volumes with both ways of cataloging.
  266.  
  267.  
  268.           *Uncatalog:
  269.           This will remove a volume from the catalog.  This is a drastic
  270.           step.  It will erase all information including comments.  All
  271.           information, except comments, can be scanned back in quickly and
  272.           automatically; but comments must be re-entered manually.  You may
  273.           want to uncatalog a disk if you find a duplicate on it using the
  274.           SEARCH DUPLICATES option.  If you find a duplicate make a note of
  275.           it and use the DELETE FILE option.  Since this is such a drastic
  276.           step, you will be asked to confirm your choice.
  277.  
  278.  
  279.  
  280.           Search Menu Options:
  281.           --------------------
  282.  
  283.           *Duplicates:
  284.           This checks through the whole catalog and compares the CRC value
  285.           of each file with every other file.  If two files have a matching
  286.           CRC value, there is a good chance that the files are the same.
  287.           These files are reported, so you can delete them if needed.  The
  288.           CRC calculated is a CRC of only a limited number of bytes of the
  289.           file.  This allows much faster cataloging and eliminates CRCs
  290.           that are different because of a few stray bytes at the end of the
  291.           file.  I have over 1300 files cataloged and don't have any false
  292.           reports at this time.
  293.  
  294.  
  295.  
  296.                                                                         6
  297.  
  298.  
  299.           *Search For File:
  300.           This allows you to search for files that begin with a certain
  301.           number of characters.  For example, searching for "A*" would show
  302.           all files that start with "A".  Searching for "ALL" would find
  303.           any files called "ALL.GIF".
  304.  
  305.  
  306.           *Search By Comment:
  307.           This allows you to find files that are commented.  For example,
  308.           searching for "NUDE" would find all files in which the word
  309.           "NUDE" was added in its comment.  The search is case insensitive.
  310.  
  311.  
  312.  
  313.           List Menu Options:
  314.           ------------------
  315.  
  316.           *List All:
  317.           This will list on the screen the entire catalog, with all fields,
  318.           one screen at a time.  The number of lines per screen can be set
  319.           from the OPTIONS menu.
  320.  
  321.  
  322.           *List Volumes:
  323.           This will list on the screen a summary of all volumes.  This
  324.           includes the number of files on a volume, bytes free, etc.
  325.  
  326.  
  327.           *Files on Volume:
  328.           This will list on the screen all files on a particular specified
  329.           volume.
  330.  
  331.  
  332.  
  333.           Print Menu Options:
  334.           -------------------
  335.  
  336.           All print options allow you to print to STDPRN or a FILE.  You
  337.           are prompted for this information each time.  Both these options
  338.           are governed by the number of lines per printer page.  This can
  339.           be set from the OPTIONS menu.  You can also choose to print in
  340.           single sheet mode, from the OPTIONS menu.
  341.  
  342.  
  343.           *Full Report:
  344.           This will print all information, one file per line.  This
  345.           includes name, filesize, resolution, volume, and comment.
  346.  
  347.  
  348.  
  349.                                                                         7
  350.  
  351.  
  352.           *Universal Report:
  353.           This will print only name, filesize, and resolution.  It is
  354.           printed one file per line.  This report will contain only the
  355.           information that is file related, leaving out information
  356.           pertaining to your individual system.  This might be useful for
  357.           making a trading list.
  358.  
  359.  
  360.           *2 Column Report:
  361.           This will print name, filesize, and volume; 2 files per line.
  362.  
  363.  
  364.           *4 Column Report:
  365.           This will print name, filesize, and volume; 4 files per line.
  366.           This will require either a 132 column printer or putting your
  367.           printer into condensed mode.
  368.  
  369.  
  370.  
  371.           Options Menu:
  372.           -------------
  373.  
  374.           *Printer Lines:
  375.           Allows you to specify the number of lines to be printed on one
  376.           page.  The default is 55.
  377.  
  378.  
  379.           *Screen Lines:
  380.           Allows you to specify the number of lines to be printed on one
  381.           screen before a pause.  The default is 24.
  382.  
  383.  
  384.           *Auto-Commenting:
  385.           Allows you to either comment after every catalog (ON) or only
  386.           when chosen explicitly from the menu (OFF).
  387.  
  388.  
  389.           *Catalog Drive:
  390.           This allows you to set the drive to catalog from.  The default is
  391.           drive A:.  It also allows you to toggle between sub-directory
  392.           mode and floppy root directory mode.
  393.  
  394.  
  395.           *Viewer Path:
  396.           This allows you to specify the GIF viewer path and filename.  You
  397.           may also add up to three command line parameters.
  398.  
  399.  
  400.           *Save Configuration:
  401.           This allows you to save to GIFLOG.CFG any changes you have made
  402.           to the options.
  403.  
  404.  
  405.  
  406.                                                                         8
  407.  
  408.  
  409.           *Set Single Sheet:
  410.           This allows you to tell Giflog to wait after each printer sheet
  411.           so you can add a sheet of paper to your printer.
  412.  
  413.  
  414.  
  415.           Quit Menu:
  416.           ----------
  417.  
  418.           This will exit GIFLOG after saving any changes to the catalog
  419.           file. You may also exit GIFLOG by hitting the ESCAPE key when
  420.           there are no pulldown menus showing.  Hitting ESCAPE with a
  421.           pulldown menu showing will hide the menu.  If you want to exit
  422.           the program without saving you can hit Ctrl-C or Ctrl-Break.
  423.  
  424.  
  425.  
  426.           Technical Information:
  427.           ----------------------
  428.  
  429.           I am providing this information in case your catalog is somehow
  430.           corrupted.  With the following information you may be able to
  431.           salvage your file with an editor.  Some unpredictable events may
  432.           cause errors.  Things like corrupt GIF files may cause data file
  433.           errors.  If your data file is getting corrupted somehow, let me
  434.           know about it.  The program has very little error checking and it
  435.           assumes you will give it the right data.
  436.           This is the format of the GIFLOG.CAT file:
  437.  
  438.           {Number of volumes} {Number of files}
  439.           Volume entry 1
  440.                 :
  441.                 :
  442.           Volume entry N
  443.           File entry 1
  444.                 :
  445.                 :
  446.           File entry N
  447.  
  448.           Volume entry:
  449.  
  450.           {Volume Name}
  451.           {Zero byte}
  452.           {Space}
  453.           {Volume Index number}
  454.           {Space}
  455.           {Files in Volume}
  456.           {Space}
  457.           {Bytes free}
  458.           {Space}
  459.           {Bytes Used}
  460.           {0D}
  461.           {0A}
  462.  
  463.  
  464.  
  465.                                                                         9
  466.  
  467.  
  468.           File entry:
  469.  
  470.           {File Name}
  471.           {Space}
  472.           {Filesize}
  473.           {Space}
  474.           {Width}
  475.           {Space}
  476.           {Height}
  477.           {Space}
  478.           {Colors}
  479.           {Space}
  480.           {Index number}
  481.           {Space}
  482.           {Checksum}
  483.           {Space}
  484.           {Comment}
  485.           {00}
  486.           {0D}
  487.           {0A}
  488.  
  489.           If there is no comment a "/" is put in the comment field.
  490.  
  491.  
  492.  
  493.           Liability:
  494.           ----------
  495.  
  496.           I cannot and will not take any liability for the use or misuse of
  497.           this program.  By using Giflog you automatically agree to this.  I
  498.           use this program everyday and have not found anything dangerous in
  499.           it.  This is just a precaution on my part.
  500.  
  501.  
  502.  
  503.           Distribution:
  504.           -------------
  505.  
  506.           By all means pass this program around.  All I ask in return is:
  507.  
  508.                1) Do not remove my name or copyright.
  509.                2) Distribute the program with all the original files.
  510.                3) Contact me by one of the below means, so I know who
  511.                   is using the program.  This is the only way I can
  512.                   contact you with bug fixes, updates, and
  513.                   improvements.  I would also like your comments and
  514.                   suggestions.
  515.  
  516.           If you feel this program is useful and you use it regularly send
  517.           me some GIF files.  My mailboxes (both email and US Mail) are
  518.           always open for quality GIFs of any content.
  519.  
  520.  
  521.  
  522.                                                                         10
  523.  
  524.  
  525.           Contact me in one of the following ways:
  526.  
  527.                Internet   : mrice@dip.eecs.umich.edu (preferred)
  528.                Compuserve : 71341,2226
  529.                U.S. Mail  : Michael Rice
  530.                             6481 Crest
  531.                             Waterford, Michigan 48329
  532.  
  533.  
  534.  
  535.           Version Information:
  536.           --------------------
  537.  
  538.           v1.1:
  539.  
  540.           * Set Drive option now uses LASTDRIVE variable to allow you to
  541.           use any legal drive for cataloging.
  542.  
  543.           * Changed options settings to stay at current value if a carriage
  544.           return is entered instead of a value.
  545.  
  546.           * GIF viewer now can have up to 3 command line options.
  547.  
  548.           * Corrected a bug which resulted in incorrect comma placement.
  549.  
  550.           * Fixed bug in duplicate search function which resulted in only 7
  551.           of 8 filename characters being shown.
  552.  
  553.           * Fixed problem with backup file creation.
  554.  
  555.           * Improved Control-C/Control-Break handling
  556.  
  557.           * Implemented cataloging of subdirectories as volumes.
  558.  
  559.           * Improved Critical Error handler/DOS Error handler.
  560.  
  561.           * Provided the environment variable GIFLOG to let the user put
  562.           Giflog's files where ever he wants.
  563.  
  564.           * Added Delete File option.
  565.  
  566.           * Added a safety prompt in the Uncatalog option.
  567.  
  568.           * Printing to a file now allows you to overwrite an existing
  569.           file.
  570.  
  571.           * Improved documentation.
  572.  
  573.           * CTRL-M now toggles the mouse availability (A feature of TCU)
  574.  
  575.           * Printing to a file allows you to overwrite an existing file.
  576.  
  577.           v1.0 - Initial Release
  578.  
  579.  
  580.  
  581.                                                                         11
  582.  
  583.  
  584.           Bugs:
  585.           -----
  586.  
  587.           The previous version didn't seem to work on all machines.  The
  588.           problem seemed to occur on older machines with older BIOS dates.
  589.           Most of the trouble is on 8086 level machines, but the problem
  590.           did occur on at least one 80286 level machine.  I think this
  591.           problem is corrected in v1.1.  I have tested it on a true IBM XT
  592.           and AT and it has no problems.  If Giflog locks up your machine,
  593.           or doesn't work as it should please contact me with a complete
  594.           list of your hardware.  In this list try to include processor,
  595.           graphics display, BIOS version and date, DOS version, and any
  596.           TSRs that you have installed.
  597.  
  598.  
  599.  
  600.           Legal Stuff:
  601.           ------------
  602.  
  603.           `GIF' and `Graphics Interchange Format' are trademarks of
  604.           CompuServe Incorporated, an H&R Block Company.
  605.  
  606.           `CSHOW' and `CompuShow' are Copyright (c) Canyon State
  607.           Systems and Software.
  608.  
  609.           `VPIC' is Copyright (c) Bob Montgomery.
  610.  
  611.           `VUIMG' is Copyright (c) Offe Enterprises.
  612.